Creating the Relative Facilities File

Information about a CygNet installation's set of relative facilities can be configured as part of the Canvas application running on the CygNet host server. This information can be exported directly from the Relative Facility settings in the Backstage View within Canvas or the relative facility settings can be extracted from the Canvas Global Settings File.

Export Relative Facilities

A Canvas installation can contain a set of relative facility settings, which are configured in the Backstage View for shared use across the application, and can be exported to an xml file.

Perform the following steps to configure relative facilities, and then export the settings for use by the CygNet Well Test module:

  1. In Canvas, go to the Backstage view and configure the relative facilities. See Configuring Relative Facilities for more information.
  2. Once configured go to the Relative Facility Definitions dialog box and click Export to export your relative facility definitions to an XML file.
  3. Browse to a known location, enter a file name, and click Save.
  4. Copy this file to the location where it can be accessed by the CygNet Well Test module and rename it as RelativeFacilities.xml (or something similar).
  5. Specify the path and file name in the <RelativeFacilityFile> element in the XML configuration, as in the example above.
  6. Specify the source in the <RelativeFacilityFileSource> element, either Local or BSS, as in the example above.
  7. Save the XML configuration to the well test configuration point in the PNT.

Extract Relative Facilities from the Global Settings File

Each Canvas installation uses a set of globally configured XML-based settings, which are compiled into the global setting file (.gsf). One of the settings bound into this file is the relative facilities settings that Canvas uses. The relative facilities settings and the location of the global settings file are configured in the Backstage view of the Canvas application.

The CygNet Well Test module can also use these settings for its own relative-facility aware action types.

Perform the following steps to configure relative facilities, and then extract the settings for use by the CygNet Well Test module:

  1. In Canvas, go to the Backstage view and configure the relative facilities. See Configuring Relative Facilities for more information.
  2. Take note in the Backstage view where the Canvas global settings file is located.
  3. Retrieve the global settings file and copy it to another location.
  4. Change the .gsf extension to .zip.
  5. Uncompress the .zip (right-click the file and select Extract All…).
  6. Find the RelativeFacilityContent file in the extracted folder.
  7. Copy this file to the location where it can be accessed by the CygNet Well Test module and rename it as RelativeFacilities.xml (or something similar).
  8. Specify the path and file name in the <RelativeFacilityFile> element in the XML configuration, as in the example above.
  9. Specify the source in the <RelativeFacilityFileSource> element, either Local or BSS, as in the example above.
  10. Save the XML configuration to the well test configuration point in the PNT.